<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dmaps: XDmaPs_ChannelData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dmaps
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_dma_ps___channel_data.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XDmaPs_ChannelData Struct Reference<div class="ingroups"><a class="el" href="group__dmaps.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_dma_ps___channel_data.html" title="The XDmaPs_ChannelData is a struct to book keep individual channel of the DMAC. ">XDmaPs_ChannelData</a> is a struct to book keep individual channel of the DMAC.  
 <a href="struct_x_dma_ps___channel_data.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a08d8c39e4ba2390ea88c95a39d820e50"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#a08d8c39e4ba2390ea88c95a39d820e50">DevId</a></td></tr>
<tr class="memdesc:a08d8c39e4ba2390ea88c95a39d820e50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device id indicating which DMAC.  <a href="#a08d8c39e4ba2390ea88c95a39d820e50">More...</a><br/></td></tr>
<tr class="separator:a08d8c39e4ba2390ea88c95a39d820e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a688c5e3052dbb1956fb8139e44cc4c8e"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#a688c5e3052dbb1956fb8139e44cc4c8e">ChanId</a></td></tr>
<tr class="memdesc:a688c5e3052dbb1956fb8139e44cc4c8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Channel number of the DMAC.  <a href="#a688c5e3052dbb1956fb8139e44cc4c8e">More...</a><br/></td></tr>
<tr class="separator:a688c5e3052dbb1956fb8139e44cc4c8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad258334833157a5499605e16b821c582"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dma_ps___prog_buf.html">XDmaPs_ProgBuf</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#ad258334833157a5499605e16b821c582">ProgBufPool</a> [XDMAPS_MAX_CHAN_BUFS]</td></tr>
<tr class="memdesc:ad258334833157a5499605e16b821c582"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pool of program buffers.  <a href="#ad258334833157a5499605e16b821c582">More...</a><br/></td></tr>
<tr class="separator:ad258334833157a5499605e16b821c582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a467e0893ad92dabed349617cfefb56be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dmaps.html#gad59232da2016e1a60744cc6e11a04a98">XDmaPsDoneHandler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#a467e0893ad92dabed349617cfefb56be">DoneHandler</a></td></tr>
<tr class="memdesc:a467e0893ad92dabed349617cfefb56be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Done interrupt handler.  <a href="#a467e0893ad92dabed349617cfefb56be">More...</a><br/></td></tr>
<tr class="separator:a467e0893ad92dabed349617cfefb56be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0816a57a2212df7c540c3f2ea7e7b3b0"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#a0816a57a2212df7c540c3f2ea7e7b3b0">DoneRef</a></td></tr>
<tr class="memdesc:a0816a57a2212df7c540c3f2ea7e7b3b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Done interrupt callback data.  <a href="#a0816a57a2212df7c540c3f2ea7e7b3b0">More...</a><br/></td></tr>
<tr class="separator:a0816a57a2212df7c540c3f2ea7e7b3b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea6a90655d2a8abf180cf32733abc2a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#aea6a90655d2a8abf180cf32733abc2a3">DmaCmdToHw</a></td></tr>
<tr class="memdesc:aea6a90655d2a8abf180cf32733abc2a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">DMA command being executed.  <a href="#aea6a90655d2a8abf180cf32733abc2a3">More...</a><br/></td></tr>
<tr class="separator:aea6a90655d2a8abf180cf32733abc2a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c04806fc749b5053f2ae3327d897281"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#a9c04806fc749b5053f2ae3327d897281">DmaCmdFromHw</a></td></tr>
<tr class="memdesc:a9c04806fc749b5053f2ae3327d897281"><td class="mdescLeft">&#160;</td><td class="mdescRight">DMA command that is finished.  <a href="#a9c04806fc749b5053f2ae3327d897281">More...</a><br/></td></tr>
<tr class="separator:a9c04806fc749b5053f2ae3327d897281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d07377a17ee1ed816fa3bde5ac52c47"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dma_ps___channel_data.html#a0d07377a17ee1ed816fa3bde5ac52c47">HoldDmaProg</a></td></tr>
<tr class="memdesc:a0d07377a17ee1ed816fa3bde5ac52c47"><td class="mdescLeft">&#160;</td><td class="mdescRight">A tag indicating whether to hold the DMA program after the DMA is done.  <a href="#a0d07377a17ee1ed816fa3bde5ac52c47">More...</a><br/></td></tr>
<tr class="separator:a0d07377a17ee1ed816fa3bde5ac52c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_dma_ps___channel_data.html" title="The XDmaPs_ChannelData is a struct to book keep individual channel of the DMAC. ">XDmaPs_ChannelData</a> is a struct to book keep individual channel of the DMAC. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a688c5e3052dbb1956fb8139e44cc4c8e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned XDmaPs_ChannelData::ChanId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Channel number of the DMAC. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#ga2fed90dfba1ff9f472b40ed492d78b4c">XDmaPs_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a08d8c39e4ba2390ea88c95a39d820e50"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned XDmaPs_ChannelData::DevId</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device id indicating which DMAC. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#ga2fed90dfba1ff9f472b40ed492d78b4c">XDmaPs_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a9c04806fc749b5053f2ae3327d897281"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a>* XDmaPs_ChannelData::DmaCmdFromHw</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>DMA command that is finished. </p>
<p>This field is for debugging purpose </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>.</p>

</div>
</div>
<a class="anchor" id="aea6a90655d2a8abf180cf32733abc2a3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dma_ps___cmd.html">XDmaPs_Cmd</a>* XDmaPs_ChannelData::DmaCmdToHw</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>DMA command being executed. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>, <a class="el" href="group__dmaps.html#ga05047e523efd0dcc0e1f3ba16a32a796">XDmaPs_IsActive()</a>, and <a class="el" href="group__dmaps.html#ga3691ba115c788c4f68a05cf05c486eeb">XDmaPs_Start()</a>.</p>

</div>
</div>
<a class="anchor" id="a467e0893ad92dabed349617cfefb56be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__dmaps.html#gad59232da2016e1a60744cc6e11a04a98">XDmaPsDoneHandler</a> XDmaPs_ChannelData::DoneHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Done interrupt handler. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gaccf32b08856fbe62745a4d0552aa1bff">XDmaPs_SetDoneHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a0816a57a2212df7c540c3f2ea7e7b3b0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XDmaPs_ChannelData::DoneRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Done interrupt callback data. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gaccf32b08856fbe62745a4d0552aa1bff">XDmaPs_SetDoneHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a0d07377a17ee1ed816fa3bde5ac52c47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDmaPs_ChannelData::HoldDmaProg</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A tag indicating whether to hold the DMA program after the DMA is done. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>, and <a class="el" href="group__dmaps.html#ga3691ba115c788c4f68a05cf05c486eeb">XDmaPs_Start()</a>.</p>

</div>
</div>
<a class="anchor" id="ad258334833157a5499605e16b821c582"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dma_ps___prog_buf.html">XDmaPs_ProgBuf</a> XDmaPs_ChannelData::ProgBufPool[XDMAPS_MAX_CHAN_BUFS]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A pool of program buffers. </p>

<p>Referenced by <a class="el" href="group__dmaps.html#gae1f2b39fb5e2e8d369c3286aeada67be">XDmaPs_FaultISR()</a>, <a class="el" href="group__dmaps.html#ga96c4c2e45ab31a22f05767c24db425ea">XDmaPs_FreeDmaProg()</a>, and <a class="el" href="group__dmaps.html#gabc2e04f69037f0bdba33275ae017af8a">XDmaPs_GenDmaProg()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
